home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / trisol22.zip / TRIANGLE.DOC < prev    next >
Text File  |  1992-06-09  |  21KB  |  464 lines
  1.  
  2.                            Triangle Solitaire
  3.                          
  4.                                   v2.2
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    The object of the game is to remove all the cards from the pyramid in
  21.    pairs. The cards being removed must equal to 13 to be eligible for
  22.    removal. 
  23.  
  24.  
  25.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  26.          created in the directory you run the door from.
  27.  
  28.  
  29.  
  30.                               INSTALLATION
  31.                               ____________
  32.  
  33.  
  34.    Installation is fairly easy and straight-forward. The following steps and
  35.    examples should have you up and running in a very short period of time.
  36.    It is assumed that you are familiar with setting up DOORS on your system.
  37.    To this end, only examples of the configuration file and Door batch file
  38.    are described.
  39.  
  40.       1) Create a directory to hold all TRIANGLE file
  41.  
  42.       2) Unzip TRISOLxx.ZIP into the the above directory
  43.  
  44.          NOTE: BRUN45.EXE is not included but is required !!!
  45.  
  46.       3) Create a configuration file, with a name of your choice, or
  47.          modify the supplied TRIANGLE.CFG file. A description follows:
  48.  
  49.             **                       Location of system file (See Below)
  50.             SUNRISE-80 BBS           Your BBS Name
  51.             Al                       Sysop's First nameAP
  52.  
  53.             Lawrence                 Sysop's Last Name
  54.  
  55. |-----------------------------------------------------------------------------|
  56. | READ!     1                        CommPort  \ These 2 lines are required   |
  57. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  58. |-----------------------------------------------------------------------------|
  59.  
  60.             00000000                 Registration Number
  61.  
  62.     !   #   1                        Maximum # of Games per day
  63.                                      (Sysop gets 99, Registered version ONLY)
  64.  
  65.         #   0                        Max # of days a caller can make up, during
  66.                                      calls in one day. 0=Disable Make-up Option
  67.                                      Maximum value = 27, Minimum value = 1
  68.  
  69.         #   NONE                     Drive:\Path\Filename to contain the
  70.                                      Top Score Bulletin or enter NONE
  71.                                      for NO Bulletin creation.
  72.  
  73.         #   NONE                     Drive:\Path\Filename to contain the
  74.                                      Top Score Bulletin (Color) or enter NONE
  75.                                      for NO Bulletin creation.
  76.  
  77.         #   NONE                     Drive:\Path\Filename to contain the
  78.                                      Hall of Fame Bulletin or enter NONE
  79.                                      for NO Bulletin creation.
  80.  
  81.         #   NONE                     Drive:\Path\Filename to contain the
  82.                                      Hall of Fame Bulletin (Color) or enter NONE
  83.                                      for NO Bulletin creation.
  84.  
  85.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  86.                                      2 = Display ADOPT-A-DOOR message
  87.  
  88.         #   2                        Keyboard timeout value in Minutes
  89.  
  90.     !   #   0                        Time  Allowed in Door
  91.                                      (Sysop = Time Remaining - REG. VERSION)
  92.  
  93.         #   N                        Automatic game reset at end of month:
  94.                                        Y = Yes enable autoreset
  95.                                        N = Keep accumulating scores
  96.  
  97.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  98.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  99.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  100.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  101.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  102.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  103.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  104.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  105.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  106.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  107.          
  108.     @   #   XXXX/YYYY                 Blackout Range  From/To
  109.     @   #   XXXX/YYYY                 Blackout Range  From/To
  110.     @   #   XXXX/YYYY                 Blackout Range  From/To
  111.     @   #   XXXX/YYYY                 Blackout Range  From/To
  112.     @   #   XXXX/YYYY                 Blackout Range  From/To
  113.  
  114.           ** = Replace with ONE of the following:
  115.  
  116. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  117. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  118. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  119.                                    (Note:DOOR.SYS must be in SAME directory)
  120. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  121. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  122. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  123. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  124. C:\BBS\GTUSER.BBS               <- For GT Power 
  125.                                    * if using this option you must put the
  126.                                      ComPort # on line 5 and the Node # on
  127.                                      line 6 of the configuration file
  128.  
  129.  
  130.  
  131.  
  132.            # = Requires registration to change to a different value.
  133.            ! = See "Plays Per Day" Below
  134.            @ = See "Blackout Periods" Below
  135.  
  136.                NOTE: There are NO Blank Lines in the Config File!!
  137.  
  138.  
  139.  
  140.  
  141.       4) Create a batch file or modify the TRIANGLE file supplied. A
  142.          description of this file follows:
  143.  
  144.             ECHO off
  145.             cd\BBS\DOORS\TRIANGLE     Location of TRIANGLE files
  146.             TRIANGLE TRIANGLE.CFG     EXE filename and CFG filename (Name
  147.                                       used in creating file in #3 above)
  148.             CD\BBS
  149.             BOARD
  150.  
  151.  
  152.        5) When running in more than one node, be sure to supply a
  153.           different configuration name for each node (your choice of name).
  154.  
  155.  
  156.  
  157.                
  158.          
  159.                MAKE-UP DAYS (Registered version only)
  160.                --------------------------------------
  161.  
  162. The Make-Up-Day feature allows the caller to make up any plays he/she missed 
  163. during the current month and prior to the current call. You control whether 
  164. to allow this option, as well as the number of days the caller can make up, on
  165. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  166. configuration file, turns the option OFF, any other value (up to a max of 27)
  167. turns the option ON and dictates the number of days the caller can make up.
  168.  
  169.  
  170. NOTE:      The number of games per day is calculated as follows...
  171.  
  172.            Games Allowed per day x Number of makeup days.
  173.  
  174. Example:   Games Allowed per day = 2
  175.            Max # of makeup days  = 4
  176.  
  177. If a caller logs in on 5/8/92 and this is their first call of the month, they
  178. would have a potential of 16 games to makeup and bring them current 
  179. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  180. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8 
  181. (games allowed * max # of makeup days).
  182.  
  183.  
  184.  
  185.              HALL OF FAME BULLETINS (Registered version only)
  186.              ------------------------------------------------
  187.  
  188. The program will automatically reset the game when the first caller of the
  189. month plays the game. The score file will be cleared and a set of Hall of Fame
  190. bulletin files will be created. The files will be called SUNHOF.ASC and 
  191. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same 
  192. directory as the BETSY.EXE file. You are responsible for COPYING the files to 
  193. your bulletin area and renaming to a filename of your choice.
  194.  
  195. WARNING: The HOF files are cumulative files. That means they are read in each 
  196.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  197.          the record of prior months winners!!!!
  198.  
  199.  
  200.                           BLACKOUT PERIODS
  201.                           ________________
  202.  
  203.       Use the Blackout ranges option to define up to 5 time periods during
  204.       which you DO NOT want the Door to be played. If a caller tries to access 
  205.       the Door during the Blackout period, they will be shown a message that
  206.       contains ALL the Blackout periods you have defined, and to try the Door
  207.       at a later time.
  208.  
  209.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  210.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  211.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  212.  
  213.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  214.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  215.                    a Blackout range.
  216.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  217.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  218.  
  219.  
  220.  
  221.                           PLAYS Per DAY/DOOR Time
  222.                           _______________________
  223.  
  224.       Plays Per Day and Door Time can be controlled several ways:
  225.  
  226.       (1) You can use the Games Per Day, singular option, in the config
  227.           file above. This option, will affect ALL callers whose Security
  228.           Level is NOT defined in any of the 10 optional Security Level/
  229.           Plays Per Day entries in the config file.
  230.  
  231.       (2) You can use the Door Time, singular option, in the config file
  232.           above. This option, will affect ALL callers whose Security
  233.           Level is NOT defined in any of the 10 optional Security Level/
  234.           Plays Per Day/Door Time entries in the config file.
  235.  
  236.       (3) You can restrict the number of games a specific Security Level
  237.           will be allowed to play per day or REWARD specific Levels with 
  238.           more Plays Per Day. 
  239.  
  240.           Likewise, you can restrict the Play time for a specific Security
  241.           Level or REWARD specific Levels with more Door Time.
  242.  
  243.           These options are handled by the use of the 10 config 
  244.           entries (000=00/00). 
  245.           
  246.           The format of each entry is as follows:
  247.  
  248.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  249.                      where =  is a constant and MUST be included
  250.                      where YY is the # of games per day (must be 2 digits)
  251.                      where / is a constant and MUST be included
  252.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  253.           
  254.           If the callers Security Level is NOT defined, his/her Plays Per
  255.           Day and Door Time will be controlled by the values in items
  256.           (1) and (2), above, respectively..
  257.  
  258.           You may define up to 10 Security Levels. All unused entries must
  259.           be defined as   000=00/00
  260.         --------------------------------------------------------------------
  261.           Example: Suppose you had 3 Security Levels defined on your BBS as
  262.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  263.           wanted to set Plays Per Day as :     Subscriber=5
  264.                                            Visiting Sysop=2
  265.                                                   CoSysop=3
  266.                                                    Friend=10 
  267.           
  268.           and Door Time as follows:     Subscriber=30 minutes
  269.                                     Visiting Sysop=20 minutes
  270.                                            CoSysop=10 minutes 
  271.                                             Friend=remaining call time
  272.                                
  273.  
  274.           You would set the Individual "Games per Day" config entry to 1 and 
  275.           the individual "Door Time" to 5 minutes (these would be the 
  276.           default number of games and default Time for all Security Levels
  277.           other than 20,30 or 40... make them any number you want). Next you
  278.           would replace 4 of the Security Level entries as :  020=05/30                                               
  279.                                                               030=02/20
  280.                                                               040=03/10
  281.                                                               090=10/0
  282.  
  283.  
  284.  
  285.                         NON-STANDARD COM SUPPORT
  286.                         ________________________
  287.  
  288.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  289.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  290.       number after the configuration filename. Let's assume your Door is
  291.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  292.       passed to your Door would be:
  293.  
  294.                             FOOBAR FOOBAR.CFG /5
  295.  
  296.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  297.       normally used with COM1. No /x parameter is needed for the standard
  298.       IRQ's.
  299.  
  300.       As an alternative, you may use an environmental variable on the command
  301.       line. To use the variable (following the example above), place a 
  302.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  303.       different IRQ number for each node). The command line would now look 
  304.       like this: 
  305.  
  306.                           FOOBAR FOOBAR.CFG /%IRQ%
  307.       
  308.       This, in combination with the use of the environmental variables 
  309.       described in the MULTI-NODE SETUP section will allow you to use one 
  310.       batch file and one config file to run this door on all nodes.
  311.  
  312.  
  313.  
  314.  
  315.                            MULTI-NODE SETUP
  316.                            ________________
  317.  
  318.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  319.       ability to access a configuration file which will have its own system 
  320.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  321.       line. There are 2 ways to accomplish this:
  322.  
  323.       (1) Create a separate configuration file for each node. The only 
  324.           difference between each file would be the location of the system 
  325.           file for that particular node. For example, on my system there are 2
  326.           nodes and the first line of the config files would look like this:
  327.  
  328.                         NODE1:  H:\PCB1\DOOR.SYS
  329.                         NODE2:  H:\PCB2\DOOR.SYS
  330.  
  331.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  332.  
  333.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  334.           the following PCBoard environmental variables:
  335.  
  336.                  PCBDIR    (Directory containing the System file)
  337.                  PCBDRIVE  (Drive containing the System file)
  338.  
  339.           Thus, the first line of the SINGLE configuration file, for this Door
  340.           would look like this:
  341.  
  342.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  343.  
  344.       NOTE: This option, as described, assumes that you are running PCBoard 
  345.             14.5a software. The environmental variables are automatically 
  346.             created by the software for each node.
  347.  
  348.             HOWEVER, if you are running other BBS software you should be able
  349.             to set the variables EXACTLY as described below, for EACH node 
  350.             (more than likely in each batch file you use to bring up EACH node):
  351.  
  352.                             PCBDRIVE=C:
  353.                             ^^^^^^^^^
  354.                             PCBDIR=\NODE2
  355.                             ^^^^^^^^
  356.             
  357.             Info with a carat (^) under it, MUST be typed as is. The rest 
  358.             depends on your naming conventions. 
  359.  
  360.             This, in combination with the use of the optional environmental
  361.             variable described in the NON-STANDARD COM SUPPORT section, will
  362.             allow you to use one batch file and one config file to run this 
  363.             door on all nodes.
  364.  
  365.  
  366.  
  367.  
  368.                                ADOPT-A-DOOR
  369.                                ____________
  370.  
  371.     Having been a Sysop for a number of years, I have had my share of problems
  372.     and frustrations getting financial support for my board's upkeep. A fellow
  373.     Sysop left a message on my board, not long ago, about a concept that was
  374.     being used by several boards around the country.
  375.  
  376.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  377.     would be the same as sending in a donation, only this way it is earmarked
  378.     for registering a particular door. In a way, the user feels he/she is
  379.     "getting something in return". As a Door author I have decided to build
  380.     this concept into each of my Door programs. The concept replaces the
  381.     usual message "tell the Sysop to register this Door" we find in most
  382.     doors.
  383.  
  384.     If the Door is unregisterd then a message appears on the opening screen
  385.     to that effect. After finishing or suspending a game, a message screen
  386.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  387.     caller to contact the Sysop to find out if there is any further details
  388.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  389.     time, etc to callers that ADOPT-A-DOOR.
  390.  
  391.     If the Door has been registered, either by the Sysop or other callers,
  392.     the names of those contributors will be displayed in the closing screen.
  393.  
  394.     NOTE: If you want to display the names of the callers that contributed
  395.           to registering the Door, you must create an ASCII file called
  396.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  397.           the name(s) of the contributors (one on each line, maximum of 5
  398.           entries, each a maximum of 30 characters long). This file must be
  399.           saved, in ASCII format, and placed in the Door directory.
  400.  
  401.  
  402.  
  403.                               LEGALITIES
  404.                               __________
  405.  
  406.  
  407.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  408.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  409.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  410.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  411.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  412.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  413.       OR BREACH OF ANY WARRANTY.
  414.  
  415.  
  416.  
  417.  
  418.  
  419.                              DISTRIBUTION
  420.                              ____________
  421.  
  422.    You may make this file available for downloading from your BBS or you may
  423.    upload it to any BBS of your choice, provided that you do not make any
  424.    changes to the contents of the archive (ZIP file). The archive and its
  425.    individual contents may not be used by any service that charges any money
  426.    whatsoever, without the written permission of the author.
  427.  
  428.  
  429.  
  430.  
  431.  
  432.                              REGISTRATION
  433.                              ____________
  434.  
  435.    Registration and the subsequent insertion of the registration number into
  436.    your configuation file, allows for the display of your BBS name on the
  437.    opening and closing screen as well as the reduction of a delay built into
  438.    the opening screen display along with the ability to change certain
  439.    values in the configuration file.
  440.  
  441.    To register your copy of TRIANGLE, please fill out the registration form
  442.    (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  443.    the name and address on the form.
  444.  
  445.    Be sure to use the proper upper/lower case when filling in your name and
  446.    BBS name, as they MUST match the way you entered them in the configuration
  447.    file.             ^^^^
  448.  
  449.    Based upon information supplied on the registration form, I will pre-
  450.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  451.    up your registration number.
  452.  
  453.  
  454.  
  455.                                  MISC
  456.                                  ____
  457.  
  458.    The latest version of TRIANGLE and other fine SUNRISE DOOR programs are 
  459.    always available for download from SUNRISE-80 BBS.
  460.  
  461.    Remember, should you have any problems, questions or suggestions, be sure
  462.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  463.    PCBHints, SYSops), SMARTNET (SN_Sysops), FIDOnet 1:133/410
  464.